API endpoints

Tumble dryers

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Air vented tumble dryers: arrow image

Path

/api/v1/tumble-dryers/air-vented-tumble-dryers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Air vented tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 110mm x 220mm when printed.

Path

/api/v1/tumble-dryers/air-vented-tumble-dryers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class of the tumble dryer. Must be one of: A+++ A++ A+ A B C D	String
energyConsumption	Weighted annual energy consumption (AEC) in kWh per year, rounded up to the nearest integer. This may be up to 3 digits long.	Integer
cycleTime	Cycle time corresponding to the standard cotton programme at full load in minutes per cycle. This may be up to 3 digits long.	Integer
ratedCapacity	Rated capacity, for the standard cotton programme at full load in kg. This may be up to 2 digits long with an optional 1 decimal place.	Number
soundPowerLevel	Sound power level (weighted average value — LWA), during the drying phase, for the standard cotton programme at full load, expressed in dB . This may be up to 2 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "energyConsumption": 1, "cycleTime": 1, "ratedCapacity": 1.1, "soundPowerLevel": 1 }

Condenser tumble dryers: arrow image

Path

/api/v1/tumble-dryers/condenser-tumble-dryers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Condenser tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 110mm x 220mm when printed.

Path

/api/v1/tumble-dryers/condenser-tumble-dryers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class of the tumble dryer. Must be one of: A+++ A++ A+ A B C D	String
energyConsumption	Weighted annual energy consumption (AEC) in kWh per year, rounded up to the nearest integer. This may be up to 3 digits long.	Integer
cycleTime	Cycle time corresponding to the standard cotton programme at full load in minutes per cycle. This may be up to 3 digits long.	Integer
ratedCapacity	Rated capacity, for the standard cotton programme at full load in kg. This may be up to 2 digits long with an optional 1 decimal place.	Number
soundPowerLevel	Sound power level (weighted average value — LWA), during the drying phase, for the standard cotton programme at full load, expressed in dB . This may be up to 2 digits long.	Integer
condensationEfficiencyRating	Condensation efficiency class indicator. Must be one of: A B C D E F G	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "energyConsumption": 1, "cycleTime": 1, "ratedCapacity": 1.1, "soundPowerLevel": 1, "condensationEfficiencyRating": "A" }

Gas fired tumble dryers: arrow image

Path

/api/v1/tumble-dryers/gas-fired-tumble-dryers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class indicator. Must be one of: A+++ A++ A+ A B C D	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Gas fired tumble dryers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 110mm x 220mm when printed.

Path

/api/v1/tumble-dryers/gas-fired-tumble-dryers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class of the tumble dryer. Must be one of: A+++ A++ A+ A B C D	String
energyConsumption	Weighted annual energy consumption (AEC) in kWh per year, rounded up to the nearest integer. This may be up to 3 digits long.	Integer
cycleTime	Cycle time corresponding to the standard cotton programme at full load in minutes per cycle. This may be up to 3 digits long.	Integer
ratedCapacity	Rated capacity, for the standard cotton programme at full load in kg. This may be up to 2 digits long with an optional 1 decimal place.	Number
soundPowerLevel	Sound power level (weighted average value — LWA), during the drying phase, for the standard cotton programme at full load, expressed in dB . This may be up to 2 digits long.	Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "energyConsumption": 1, "cycleTime": 1, "ratedCapacity": 1.1, "soundPowerLevel": 1 }